FHIR © HL7.org  |  FHIRsmith 0.18.0  |  Server Home  |  XIG Home  |  XIG Stats  | 

FHIR IG analytics

Packageopenehr.base
Resource TypeStructureDefinition
IdStructureDefinition-DV-PROPORTION.json
FHIR VersionR5
Sourcehttps://build.fhir.org/ig/openehr-fhir/base-spec/StructureDefinition-DV-PROPORTION.html
URLhttp://openehr.org/fhir/StructureDefinition/DV_PROPORTION
Version0.1.0
Statusactive
Date2025-09-06T15:35:39+10:00
NameDV_PROPORTION
TitleDV_PROPORTION
Realmuv
Authorityhl7
DescriptionModels a ratio of values, i.e. where the numerator and denominator are both pure numbers. The `_valid_proportion_kind_` property of the `PROPORTION_KIND` class is used to control the type attribute to be one of a defined set. Used for recording titers (e.g. 1:128), concentration ratios, e.g. Na:K (unitary denominator), albumin:creatinine ratio, and percentages, e.g. red cell distirbution width (RDW). Misuse: Should not be used to represent things like blood pressure which are often written using a '/' character, giving the misleading impression that the item is a ratio, when in fact it is a structured value. Similarly, visual acuity, often written as (e.g.) "6/24" in clinical notes is not a ratio but an ordinal (which includes non-numeric symbols like CF = count fingers etc). Should not be used for formulations.
Typehttp://openehr.org/fhir/StructureDefinition/DV_PROPORTION
Kindlogical

Resources that use this resource

No resources found


Resources that this resource uses

StructureDefinition
openehr.base#currentDV_AMOUNTDV_AMOUNT
openehr.base#currentDV_INTERVALDV_INTERVAL
openehr.base#currentREFERENCE_RANGEREFERENCE_RANGE

Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: StructureDefinition DV-PROPORTION

NameFlagsCard.TypeDescription & Constraintsdoco
.. DV_PROPORTION C0..*DV_AMOUNTModels a ratio of values

Elements defined in Ancestors:CR, LF, Local_terminology_id, normal_status, normal_range, other_reference_ranges, magnitude_status, accuracy, accuracy_is_percent, accuracy
Instances of this logical model are not marked to be the target of a Reference
Constraints: type-validity, precision-validity, is-integral-validity, fraction-validity, unitary-validity, percent-validity, valid-denominator
... numerator 1..1decimalNumerator of ratio
... denominator 1..1decimalDenominator of ratio.
... type 1..1integerIndicates semantic type of proportion, including percent, unitary etc.
... precision 0..1integerPrecision to which the `_numerator_` and `_denominator_` values of the proportion are expressed, in terms of number of decimal places.
... normal_range 0..1DV_INTERVAL<http://openehr.org/fhir/StructureDefinition/DV-PROPORTION>Optional normal range.
... other_reference_ranges 0..*REFERENCE_RANGE<http://openehr.org/fhir/StructureDefinition/DV-PROPORTION>Optional tagged other reference ranges for this value in its particular measurement context.

doco Documentation for this format

Source1

{
  "resourceType": "StructureDefinition",
  "id": "DV-PROPORTION",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "contained": [
    {
      "resourceType": "OperationDefinition",
      "id": "magnitude",
      "name": "magnitude",
      "title": "magnitude",
      "status": "active",
      "kind": "operation",
      "description": "Effective magnitude represented by ratio.",
      "code": "magnitude",
      "system": false,
      "type": false,
      "instance": true,
      "parameter": [
        {
          "name": "return",
          "use": "out",
          "min": 1,
          "max": "1",
          "type": "decimal"
        }
      ]
    },
    {
      "resourceType": "OperationDefinition",
      "id": "is-integral",
      "name": "is_integral",
      "title": "is_integral",
      "status": "active",
      "kind": "operation",
      "description": "True if the `_numerator_` and `_denominator_` values are integers, i.e. if `_precision_` is 0.",
      "code": "is_integral",
      "system": false,
      "type": false,
      "instance": true,
      "parameter": [
        {
          "name": "return",
          "use": "out",
          "min": 1,
          "max": "1",
          "type": "boolean"
        }
      ]
    },
    {
      "resourceType": "OperationDefinition",
      "id": "add",
      "name": "add",
      "title": "add",
      "status": "active",
      "kind": "operation",
      "description": "Sum of two strictly comparable proportions.",
      "code": "add",
      "system": false,
      "type": false,
      "instance": true,
      "parameter": [
        {
          "name": "other",
          "use": "in",
          "min": 1,
          "max": "1",
          "type": "decimal"
        },
        {
          "name": "return",
          "use": "out",
          "min": 1,
          "max": "1",
          "type": "decimal"
        }
      ]
    },
    {
      "resourceType": "OperationDefinition",
      "id": "subtract",
      "name": "subtract",
      "title": "subtract",
      "status": "active",
      "kind": "operation",
      "description": "Difference between two strictly comparable proportions.",
      "code": "subtract",
      "system": false,
      "type": false,
      "instance": true,
      "parameter": [
        {
          "name": "other",
          "use": "in",
          "min": 1,
          "max": "1",
          "type": "decimal"
        },
        {
          "name": "return",
          "use": "out",
          "min": 1,
          "max": "1",
          "type": "decimal"
        }
      ]
    },
    {
      "resourceType": "OperationDefinition",
      "id": "is-equal",
      "name": "is_equal",
      "title": "is_equal",
      "status": "active",
      "kind": "operation",
      "description": "Return True if this `DV-AMOUNT` is considered equal to `_other_`.",
      "code": "is_equal",
      "system": false,
      "type": false,
      "instance": true,
      "parameter": [
        {
          "name": "other",
          "use": "in",
          "min": 1,
          "max": "1",
          "type": "decimal"
        },
        {
          "name": "return",
          "use": "out",
          "min": 1,
          "max": "1",
          "type": "boolean"
        }
      ]
    },
    {
      "resourceType": "OperationDefinition",
      "id": "multiply",
      "name": "multiply",
      "title": "multiply",
      "status": "active",
      "kind": "operation",
      "description": "Product of this Proportion and `_factor_`.",
      "code": "multiply",
      "system": false,
      "type": false,
      "instance": true,
      "parameter": [
        {
          "name": "factor",
          "use": "in",
          "min": 1,
          "max": "1",
          "type": "decimal"
        },
        {
          "name": "return",
          "use": "out",
          "min": 1,
          "max": "1",
          "type": "decimal"
        }
      ]
    },
    {
      "resourceType": "OperationDefinition",
      "id": "less-than",
      "name": "less_than",
      "title": "less_than",
      "status": "active",
      "kind": "operation",
      "description": "True if this Proportion is less than  `_other_`. Only valid if `_is_strictly_comparable_to()_` is True.",
      "code": "less_than",
      "system": false,
      "type": false,
      "instance": true,
      "parameter": [
        {
          "name": "other",
          "use": "in",
          "min": 1,
          "max": "1",
          "type": "decimal"
        },
        {
          "name": "return",
          "use": "out",
          "min": 1,
          "max": "1",
          "type": "boolean"
        }
      ]
    },
    {
      "resourceType": "OperationDefinition",
      "id": "is-strictly-comparable-to",
      "name": "is_strictly_comparable_to",
      "title": "is_strictly_comparable_to",
      "status": "active",
      "kind": "operation",
      "description": "Return True if the `_type_` of this proportion is the same as the `_type_` of `_other_`.",
      "code": "is_strictly_comparable_to",
      "system": false,
      "type": false,
      "instance": true,
      "parameter": [
        {
          "name": "other",
          "use": "in",
          "min": 1,
          "max": "1",
          "type": "Parameters"
        },
        {
          "name": "return",
          "use": "out",
          "min": 1,
          "max": "1",
          "type": "boolean"
        }
      ]
    }
  ],
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/web-source",
      "valueUrl": "https://specifications.openehr.org/releases/RM/Release-1.1.0/data_types.html#_dv_proportion_class"
    },
    {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/type-operation",
      "valueCanonical": "#magnitude"
    },
    {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/type-operation",
      "valueCanonical": "#is-integral"
    },
    {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/type-operation",
      "valueCanonical": "#add"
    },
    {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/type-operation",
      "valueCanonical": "#subtract"
    },
    {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/type-operation",
      "valueCanonical": "#is-equal"
    },
    {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/type-operation",
      "valueCanonical": "#multiply"
    },
    {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/type-operation",
      "valueCanonical": "#less-than"
    },
    {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/type-operation",
      "valueCanonical": "#is-strictly-comparable-to"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "fhir"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
      "valueCode": "has-range"
    },
    {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/view-hint",
      "valueCode": "element-view-as-leaf"
    },
    {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/view-hint",
      "valueCode": "element-view-defns-parent"
    },
    {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/view-hint",
      "valueCode": "element-view-replace-cardinality"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 3,
      "_valueInteger": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://openehr.org/fhir/ImplementationGuide/openehr.base"
          }
        ]
      }
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode": "informative",
      "_valueCode": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://openehr.org/fhir/ImplementationGuide/openehr.base"
          }
        ]
      }
    }
  ],
  "url": "http://openehr.org/fhir/StructureDefinition/DV_PROPORTION",
  "version": "0.1.0",
  "name": "DV_PROPORTION",
  "title": "DV_PROPORTION",
  "status": "active",
  "experimental": false,
  "date": "2025-09-06T15:35:39+10:00",
  "publisher": "openEHR + HL7",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://www.openehr.org"
        }
      ]
    }
  ],
  "description": "Models a ratio of values, i.e. where the numerator and denominator are both pure numbers. The `_valid_proportion_kind_` property of the `PROPORTION_KIND` class is used to control the type attribute to be one of a defined set.\n\nUsed for recording titers (e.g. 1:128), concentration ratios, e.g. Na:K (unitary denominator), albumin:creatinine ratio, and percentages, e.g. red cell distirbution width (RDW). \n \nMisuse: Should not be used to represent things like blood pressure which are often written using a  '/' character, giving the misleading impression that the item is a ratio, when in fact it is a structured value. Similarly, visual acuity, often written as (e.g.) \"6/24\" in clinical notes is not a ratio but an ordinal (which includes non-numeric symbols like CF = count fingers etc). Should not be used for formulations.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "001"
        }
      ]
    }
  ],
  "fhirVersion": "5.0.0",
  "mapping": [
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM Mapping"
    }
  ],
  "kind": "logical",
  "abstract": false,
  "type": "http://openehr.org/fhir/StructureDefinition/DV_PROPORTION",
  "baseDefinition": "http://openehr.org/fhir/StructureDefinition/DV_AMOUNT",
  "derivation": "specialization",
  "snapshot": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
        "valueString": "0.1.0"
      }
    ],
    "element": [
      {
        "id": "DV_PROPORTION",
        "path": "DV_PROPORTION",
        "short": "Models a ratio of values",
        "definition": "Models a ratio of values, i.e. where the numerator and denominator are both pure numbers. The `_valid_proportion_kind_` property of the `PROPORTION_KIND` class is used to control the type attribute to be one of a defined set.\n\nUsed for recording titers (e.g. 1:128), concentration ratios, e.g. Na:K (unitary denominator), albumin:creatinine ratio, and percentages, e.g. red cell distirbution width (RDW). \n \nMisuse: Should not be used to represent things like blood pressure which are often written using a  '/' character, giving the misleading impression that the item is a ratio, when in fact it is a structured value. Similarly, visual acuity, often written as (e.g.) \"6/24\" in clinical notes is not a ratio but an ordinal (which includes non-numeric symbols like CF = count fingers etc). Should not be used for formulations.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Base",
          "min": 0,
          "max": "*"
        },
        "constraint": [
          {
            "key": "other-reference-ranges-validity",
            "severity": "error",
            "human": "Other reference ranges validity must be present",
            "expression": "other_reference_ranges.exists() implies other_reference_ranges.empty().not()",
            "source": "http://openehr.org/fhir/StructureDefinition/DV_ORDERED"
          },
          {
            "key": "is-simple-validity",
            "severity": "error",
            "human": "Is simple validity must satisfy conditional constraints",
            "expression": "(normal_range .empty() and other_reference_ranges .empty()) implies is_simple()",
            "source": "http://openehr.org/fhir/StructureDefinition/DV_ORDERED"
          },
          {
            "key": "normal-range-and-status-consistency",
            "severity": "error",
            "human": "Normal range and status consistency must be present",
            "expression": "(normal_range.exists() and normal_status.exists()) implies (normal_status.code_string.is_equal ('N') xor normal_range.not().has (self))",
            "source": "http://openehr.org/fhir/StructureDefinition/DV_ORDERED"
          },
          {
            "key": "magnitude-status-valid",
            "severity": "error",
            "human": "Magnitude status valid must be present",
            "expression": "magnitude_status.exists() implies valid_magnitude_status()",
            "source": "http://openehr.org/fhir/StructureDefinition/DV_QUANTIFIED"
          },
          {
            "key": "accuracy-is-percent-validity",
            "severity": "error",
            "human": "Accuracy is percent validity must satisfy conditional constraints",
            "expression": "accuracy = 0 implies accuracy_is_percent.not()",
            "source": "http://openehr.org/fhir/StructureDefinition/DV_AMOUNT"
          },
          {
            "key": "accuracy-validity",
            "severity": "error",
            "human": "Accuracy validity must satisfy conditional constraints",
            "expression": "accuracy_is_percent implies valid_percentage()",
            "source": "http://openehr.org/fhir/StructureDefinition/DV_AMOUNT"
          },
          {
            "key": "type-validity",
            "severity": "error",
            "human": "Type validity",
            "expression": "{} // : manual translation needed"
          },
          {
            "key": "precision-validity",
            "severity": "error",
            "human": "Precision validity must satisfy conditional constraints",
            "expression": "precision = 0 implies is_integral()"
          },
          {
            "key": "is-integral-validity",
            "severity": "error",
            "human": "Is integral validity must satisfy conditional constraints",
            "expression": "is_integral() implies (numerator.floor = numerator and denominator.floor = denominator)"
          },
          {
            "key": "fraction-validity",
            "severity": "error",
            "human": "Fraction validity must satisfy conditional constraints",
            "expression": "(type = pk_fraction or type = pk_integer_fraction) implies is_integral()"
          },
          {
            "key": "unitary-validity",
            "severity": "error",
            "human": "Unitary validity must satisfy conditional constraints",
            "expression": "{} // : manual translation needed"
          },
          {
            "key": "percent-validity",
            "severity": "error",
            "human": "Percent validity must satisfy conditional constraints",
            "expression": "{} // : manual translation needed"
          },
          {
            "key": "valid-denominator",
            "severity": "error",
            "human": "Valid denominator",
            "expression": "{} // : manual translation needed"
          }
        ],
        "isModifier": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "DV_PROPORTION.CR",
        "path": "DV_PROPORTION.CR",
        "short": "Carriage return character.",
        "definition": "Carriage return character.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "BASIC_DEFINITIONS.CR",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "string"
          }
        ],
        "isModifier": false
      },
      {
        "id": "DV_PROPORTION.LF",
        "path": "DV_PROPORTION.LF",
        "short": "Line feed character.",
        "definition": "Line feed character.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "BASIC_DEFINITIONS.LF",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "string"
          }
        ],
        "isModifier": false
      },
      {
        "id": "DV_PROPORTION.Local-terminology-id",
        "path": "DV_PROPORTION.Local_terminology_id",
        "short": "Predefined terminology identifier",
        "definition": "Predefined terminology identifier to indicate it is local to the knowledge resource in which it occurs, e.g. an archetype",
        "min": 1,
        "max": "1",
        "base": {
          "path": "OPENEHR_DEFINITIONS.Local_terminology_id",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "string"
          }
        ],
        "isModifier": false
      },
      {
        "id": "DV_PROPORTION.normal-status",
        "path": "DV_PROPORTION.normal_status",
        "short": "Optional normal status indicator of value with respect to normal range for this value.",
        "definition": "Optional normal status indicator of value with respect to normal range for this value. Often included by lab, even if the normal range itself is not included. Coded by ordinals in series HHH, HH, H, (nothing), L, LL, LLL; see openEHR terminology group  `normal_status`.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "DV_ORDERED.normal_status",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/CODE_PHRASE"
          }
        ],
        "isModifier": false
      },
      {
        "id": "DV_PROPORTION.normal-range",
        "path": "DV_PROPORTION.normal_range",
        "short": "Optional normal range.",
        "definition": "Optional normal range.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "DV_ORDERED.normal_range",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "extension": [
              {
                "extension": [
                  {
                    "url": "name",
                    "valueCode": "T"
                  },
                  {
                    "url": "type",
                    "valueUri": "http://openehr.org/fhir/StructureDefinition/DV-PROPORTION"
                  }
                ],
                "url": "http://hl7.org/fhir/tools/StructureDefinition/type-parameter"
              }
            ],
            "code": "http://openehr.org/fhir/StructureDefinition/DV_INTERVAL"
          }
        ],
        "isModifier": false
      },
      {
        "id": "DV_PROPORTION.other-reference-ranges",
        "path": "DV_PROPORTION.other_reference_ranges",
        "short": "Optional tagged other reference ranges for this value in its particular measurement context.",
        "definition": "Optional tagged other reference ranges for this value in its particular measurement context.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "DV_ORDERED.other_reference_ranges",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "extension": [
              {
                "extension": [
                  {
                    "url": "name",
                    "valueCode": "T"
                  },
                  {
                    "url": "type",
                    "valueUri": "http://openehr.org/fhir/StructureDefinition/DV-PROPORTION"
                  }
                ],
                "url": "http://hl7.org/fhir/tools/StructureDefinition/type-parameter"
              }
            ],
            "code": "http://openehr.org/fhir/StructureDefinition/REFERENCE_RANGE"
          }
        ],
        "isModifier": false
      },
      {
        "id": "DV_PROPORTION.magnitude-status",
        "path": "DV_PROPORTION.magnitude_status",
        "short": "Optional status of magnitude with values: \n\n* `\"=\"`   :   magnitude is a point value \n* `\"<\"`   :   value is < magnitude \n* `\">\"`   :   value is > magnitude \n* `\"<=\"` : value is <= magnitude \n* `\">=\"` : value is >= magnitude \n* `\"~\"`   :   value is approximately magnitude \n\nIf not present, assumed meaning is  `\"=\"`.",
        "definition": "Optional status of magnitude with values: \n\n* `\"=\"`   :   magnitude is a point value \n* `\"<\"`   :   value is < magnitude \n* `\">\"`   :   value is > magnitude \n* `\"<=\"` : value is <= magnitude \n* `\">=\"` : value is >= magnitude \n* `\"~\"`   :   value is approximately magnitude \n\nIf not present, assumed meaning is  `\"=\"`.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "DV_QUANTIFIED.magnitude_status",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "string"
          }
        ],
        "isModifier": false
      },
      {
        "id": "DV_PROPORTION.accuracy",
        "path": "DV_PROPORTION.accuracy",
        "short": "Accuracy of measurement, expressed either as a half-range percent value (`_accuracy_is_percent_` = `True`) or a half-range quantity.",
        "definition": "Accuracy of measurement, expressed either as a half-range percent value (`_accuracy_is_percent_` = `True`) or a half-range quantity. A value of `0` means that accuracy is 100%, i.e. no error.\n\nA value of `_unknown_accuracy_value_` means that accuracy was not recorded.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "DV_QUANTIFIED.accuracy",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "decimal"
          }
        ],
        "isModifier": false
      },
      {
        "id": "DV_PROPORTION.accuracy-is-percent",
        "path": "DV_PROPORTION.accuracy_is_percent",
        "short": "If `True`, indicates that when this object was created, `_accuracy_` was recorded as a percent value; if `False`, as an absolute quantity value.",
        "definition": "If `True`, indicates that when this object was created, `_accuracy_` was recorded as a percent value; if `False`, as an absolute quantity value.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "DV_AMOUNT.accuracy_is_percent",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "boolean"
          }
        ],
        "isModifier": false
      },
      {
        "id": "DV_PROPORTION.numerator",
        "path": "DV_PROPORTION.numerator",
        "short": "Numerator of ratio",
        "definition": "Numerator of ratio",
        "min": 1,
        "max": "1",
        "base": {
          "path": "DV_PROPORTION.numerator",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "decimal"
          }
        ],
        "isModifier": false
      },
      {
        "id": "DV_PROPORTION.denominator",
        "path": "DV_PROPORTION.denominator",
        "short": "Denominator of ratio.",
        "definition": "Denominator of ratio.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "DV_PROPORTION.denominator",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "decimal"
          }
        ],
        "isModifier": false
      },
      {
        "id": "DV_PROPORTION.type",
        "path": "DV_PROPORTION.type",
        "short": "Indicates semantic type of proportion, including percent, unitary etc.",
        "definition": "Indicates semantic type of proportion, including percent, unitary etc.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "DV_PROPORTION.type",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "integer"
          }
        ],
        "isModifier": false
      },
      {
        "id": "DV_PROPORTION.precision",
        "path": "DV_PROPORTION.precision",
        "short": "Precision  to  which  the  `_numerator_` and `_denominator_` values of  the  proportion are expressed, in terms of number  of decimal places.",
        "definition": "Precision  to  which  the  `_numerator_` and `_denominator_` values of  the  proportion are expressed, in terms of number  of decimal places. The value 0 implies an integral quantity. The value -1 implies no limit, i.e. any number of decimal places.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "DV_PROPORTION.precision",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "integer"
          }
        ],
        "isModifier": false
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "DV_PROPORTION",
        "path": "DV_PROPORTION",
        "short": "Models a ratio of values",
        "definition": "Models a ratio of values, i.e. where the numerator and denominator are both pure numbers. The `_valid_proportion_kind_` property of the `PROPORTION_KIND` class is used to control the type attribute to be one of a defined set.\n\nUsed for recording titers (e.g. 1:128), concentration ratios, e.g. Na:K (unitary denominator), albumin:creatinine ratio, and percentages, e.g. red cell distirbution width (RDW). \n \nMisuse: Should not be used to represent things like blood pressure which are often written using a  '/' character, giving the misleading impression that the item is a ratio, when in fact it is a structured value. Similarly, visual acuity, often written as (e.g.) \"6/24\" in clinical notes is not a ratio but an ordinal (which includes non-numeric symbols like CF = count fingers etc). Should not be used for formulations.",
        "min": 0,
        "max": "*",
        "constraint": [
          {
            "key": "type-validity",
            "severity": "error",
            "human": "Type validity",
            "expression": "{} // : manual translation needed"
          },
          {
            "key": "precision-validity",
            "severity": "error",
            "human": "Precision validity must satisfy conditional constraints",
            "expression": "precision = 0 implies is_integral()"
          },
          {
            "key": "is-integral-validity",
            "severity": "error",
            "human": "Is integral validity must satisfy conditional constraints",
            "expression": "is_integral() implies (numerator.floor = numerator and denominator.floor = denominator)"
          },
          {
            "key": "fraction-validity",
            "severity": "error",
            "human": "Fraction validity must satisfy conditional constraints",
            "expression": "(type = pk_fraction or type = pk_integer_fraction) implies is_integral()"
          },
          {
            "key": "unitary-validity",
            "severity": "error",
            "human": "Unitary validity must satisfy conditional constraints",
            "expression": "{} // : manual translation needed"
          },
          {
            "key": "percent-validity",
            "severity": "error",
            "human": "Percent validity must satisfy conditional constraints",
            "expression": "{} // : manual translation needed"
          },
          {
            "key": "valid-denominator",
            "severity": "error",
            "human": "Valid denominator",
            "expression": "{} // : manual translation needed"
          }
        ],
        "isModifier": false
      },
      {
        "id": "DV_PROPORTION.numerator",
        "path": "DV_PROPORTION.numerator",
        "short": "Numerator of ratio",
        "definition": "Numerator of ratio",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "decimal"
          }
        ],
        "isModifier": false
      },
      {
        "id": "DV_PROPORTION.denominator",
        "path": "DV_PROPORTION.denominator",
        "short": "Denominator of ratio.",
        "definition": "Denominator of ratio.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "decimal"
          }
        ],
        "isModifier": false
      },
      {
        "id": "DV_PROPORTION.type",
        "path": "DV_PROPORTION.type",
        "short": "Indicates semantic type of proportion, including percent, unitary etc.",
        "definition": "Indicates semantic type of proportion, including percent, unitary etc.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "integer"
          }
        ],
        "isModifier": false
      },
      {
        "id": "DV_PROPORTION.precision",
        "path": "DV_PROPORTION.precision",
        "short": "Precision  to  which  the  `_numerator_` and `_denominator_` values of  the  proportion are expressed, in terms of number  of decimal places.",
        "definition": "Precision  to  which  the  `_numerator_` and `_denominator_` values of  the  proportion are expressed, in terms of number  of decimal places. The value 0 implies an integral quantity. The value -1 implies no limit, i.e. any number of decimal places.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "integer"
          }
        ],
        "isModifier": false
      },
      {
        "id": "DV_PROPORTION.normal-range",
        "path": "DV_PROPORTION.normal_range",
        "short": "Optional normal range.",
        "definition": "Optional normal range.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "extension": [
              {
                "extension": [
                  {
                    "url": "name",
                    "valueCode": "T"
                  },
                  {
                    "url": "type",
                    "valueUri": "http://openehr.org/fhir/StructureDefinition/DV-PROPORTION"
                  }
                ],
                "url": "http://hl7.org/fhir/tools/StructureDefinition/type-parameter"
              }
            ],
            "code": "http://openehr.org/fhir/StructureDefinition/DV_INTERVAL"
          }
        ],
        "isModifier": false
      },
      {
        "id": "DV_PROPORTION.other-reference-ranges",
        "path": "DV_PROPORTION.other_reference_ranges",
        "short": "Optional tagged other reference ranges for this value in its particular measurement context.",
        "definition": "Optional tagged other reference ranges for this value in its particular measurement context.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "extension": [
              {
                "extension": [
                  {
                    "url": "name",
                    "valueCode": "T"
                  },
                  {
                    "url": "type",
                    "valueUri": "http://openehr.org/fhir/StructureDefinition/DV-PROPORTION"
                  }
                ],
                "url": "http://hl7.org/fhir/tools/StructureDefinition/type-parameter"
              }
            ],
            "code": "http://openehr.org/fhir/StructureDefinition/REFERENCE_RANGE"
          }
        ],
        "isModifier": false
      }
    ]
  }
}